//
// Encog(tm) Core v3.2 - .Net Version
// http://www.heatonresearch.com/encog/
//
// Copyright 2008-2013 Heaton Research, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//  http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//   
// For more information on Heaton Research copyrights, licenses 
// and trademarks visit:
// http://www.heatonresearch.com/copyright
//

using Encog.ML.EA.Genome;
using Encog.ML.EA.Species;

namespace Encog.ML.Prg.Species
{
    /// <summary>
    ///     Perform speciation for two Encog programs. This is a threshold based
    ///     speciation, similar to that used for NEAT. Any genomes with a compatibility
    ///     score below a specified threshold will be in the same species.
    /// </summary>
    public class PrgSpeciation : ThresholdSpeciation
    {
        /// <summary>
        /// Construct the object.
        /// </summary>
        public PrgSpeciation()
        {
            CompatibilityThreshold = 15;
            MaxNumberOfSpecies = 30;
            NumGensAllowedNoImprovement = 15;
        }

        /// <inheritdoc />
        public override double GetCompatibilityScore(IGenome genome1,
                                                     IGenome genome2)
        {
            var comp = new CompareEncogProgram();
            double d = comp.Compare((EncogProgram) genome1,
                                    (EncogProgram) genome2);
            return d;
        }
    }
}